home *** CD-ROM | disk | FTP | other *** search
- /* vim:set ts=4 sw=4 et cindent: */
- /* ***** BEGIN LICENSE BLOCK *****
- * Version: MPL 1.1/GPL 2.0/LGPL 2.1
- *
- * The contents of this file are subject to the Mozilla Public License Version
- * 1.1 (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- * http://www.mozilla.org/MPL/
- *
- * Software distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
- * for the specific language governing rights and limitations under the
- * License.
- *
- * The Original Code is Mozilla.
- *
- * The Initial Developer of the Original Code is IBM Corporation.
- * Portions created by IBM Corporation are Copyright (C) 2003
- * IBM Corporation. All Rights Reserved.
- *
- * Contributor(s):
- * Darin Fisher <darin@meer.net>
- *
- * Alternatively, the contents of this file may be used under the terms of
- * either the GNU General Public License Version 2 or later (the "GPL"), or
- * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
- * in which case the provisions of the GPL or the LGPL are applicable instead
- * of those above. If you wish to allow use of your version of this file only
- * under the terms of either the GPL or the LGPL, and not to allow others to
- * use your version of this file under the terms of the MPL, indicate your
- * decision by deleting the provisions above and replace them with the notice
- * and other provisions required by the GPL or the LGPL. If you do not delete
- * the provisions above, a recipient may use your version of this file under
- * the terms of any one of the MPL, the GPL or the LGPL.
- *
- * ***** END LICENSE BLOCK ***** */
-
- #include "nsISupports.idl"
-
- interface nsIServerSocketListener;
- interface nsISocketTransport;
-
- native PRNetAddr(union PRNetAddr);
- [ptr] native PRNetAddrPtr(union PRNetAddr);
-
- /**
- * nsIServerSocket
- *
- * An interface to a server socket that can accept incoming connections.
- */
- [scriptable, uuid(a5b64be0-d563-46bb-ae95-132e46fcd42f)]
- interface nsIServerSocket : nsISupports
- {
- /**
- * init
- *
- * This method initializes a server socket.
- *
- * @param aPort
- * The port of the server socket. Pass -1 to indicate no preference,
- * and a port will be selected automatically.
- * @param aLoopbackOnly
- * If true, the server socket will only respond to connections on the
- * local loopback interface. Otherwise, it will accept connections
- * from any interface. To specify a particular network interface,
- * use initWithAddress.
- * @param aBackLog
- * The maximum length the queue of pending connections may grow to.
- * This parameter may be silently limited by the operating system.
- * Pass -1 to use the default value.
- */
- void init(in long aPort, in boolean aLoopbackOnly, in long aBackLog);
-
- /**
- * initWithAddress
- *
- * This method initializes a server socket, and binds it to a particular
- * local address (and hence a particular local network interface).
- *
- * @param aAddr
- * The address to which this server socket should be bound.
- * @param aBackLog
- * The maximum length the queue of pending connections may grow to.
- * This parameter may be silently limited by the operating system.
- * Pass -1 to use the default value.
- */
- [noscript] void initWithAddress([const] in PRNetAddrPtr aAddr, in long aBackLog);
-
- /**
- * close
- *
- * This method closes a server socket. This does not affect already
- * connected client sockets (i.e., the nsISocketTransport instances
- * created from this server socket). This will cause the onStopListening
- * event to asynchronously fire with a status of NS_BINDING_ABORTED.
- */
- void close();
-
- /**
- * asyncListen
- *
- * This method puts the server socket in the listening state. It will
- * asynchronously listen for and accept client connections. The listener
- * will be notified once for each client connection that is accepted. The
- * listener's onSocketAccepted method will be called on the same thread
- * that called asyncListen (the calling thread must have a nsIEventTarget).
- *
- * The listener will be passed a reference to an already connected socket
- * transport (nsISocketTransport). See below for more details.
- *
- * @param aListener
- * The listener to be notified when client connections are accepted.
- */
- void asyncListen(in nsIServerSocketListener aListener);
-
- /**
- * Returns the port of this server socket.
- */
- readonly attribute long port;
-
- /**
- * Returns the address to which this server socket is bound. Since a
- * server socket may be bound to multiple network devices, this address
- * may not necessarily be specific to a single network device. In the
- * case of an IP socket, the IP address field would be zerod out to
- * indicate a server socket bound to all network devices. Therefore,
- * this method cannot be used to determine the IP address of the local
- * system. See nsIDNSService::myHostName if this is what you need.
- */
- [noscript] PRNetAddr getAddress();
- };
-
- /**
- * nsIServerSocketListener
- *
- * This interface is notified whenever a server socket accepts a new connection.
- * The transport is in the connected state, and read/write streams can be opened
- * using the normal nsITransport API. The address of the client can be found by
- * calling the nsISocketTransport::GetAddress method or by inspecting
- * nsISocketTransport::GetHost, which returns a string representation of the
- * client's IP address (NOTE: this may be an IPv4 or IPv6 string literal).
- */
- [scriptable, uuid(836d98ec-fee2-4bde-b609-abd5e966eabd)]
- interface nsIServerSocketListener : nsISupports
- {
- /**
- * onSocketAccepted
- *
- * This method is called when a client connection is accepted.
- *
- * @param aServ
- * The server socket.
- * @param aTransport
- * The connected socket transport.
- */
- void onSocketAccepted(in nsIServerSocket aServ,
- in nsISocketTransport aTransport);
-
- /**
- * onStopListening
- *
- * This method is called when the listening socket stops for some reason.
- * The server socket is effectively dead after this notification.
- *
- * @param aServ
- * The server socket.
- * @param aStatus
- * The reason why the server socket stopped listening. If the
- * server socket was manually closed, then this value will be
- * NS_BINDING_ABORTED.
- */
- void onStopListening(in nsIServerSocket aServ, in nsresult aStatus);
- };
-